/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package org.dinky.service;

import org.dinky.data.dto.LoginDTO;
import org.dinky.data.exception.AuthException;
import org.dinky.data.model.rbac.User;

import java.util.List;

import javax.naming.NamingException;

public interface LdapService {

    /**
     * List all users.
     *
     * @return A list of {@link User} objects representing all users.
     */
    List<User> listUsers();

    /**
     * Authenticates the user based on the provided login credentials. Throws AuthException if
     * authentication fails.
     *
     * @param loginDTO The login user info
     * @return ldap user
     */
    User authenticate(LoginDTO loginDTO) throws AuthException, NamingException;
}
